home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d7 / faxdor14.arc / FAXDOR13.DOC < prev    next >
Text File  |  1991-04-28  |  19KB  |  407 lines

  1.  
  2.  
  3.  
  4. ==============================================================================
  5.  
  6.                           Fax-Door Release 1.03
  7.  
  8.                     Fax ASCII Text file on the spot!
  9.  
  10.                    Door Registration is only $10.00!
  11.  
  12.               Written by: Gerry Freymann
  13.                           R.R.#1
  14.                           Baltimore, Ontario Canada
  15.                           K0K 1C0
  16.  
  17.           The Phantom BBS (416) 342-3734 USR HST Dual Standard
  18.                           (416) 342-3766 19200 USR HST
  19.                           (416) 342-5573 19200 Hayes Ultra
  20. ==============================================================================
  21.  
  22.  
  23.  
  24.  
  25.  
  26. Brief Update History
  27. -------------------------------------------------------------------------
  28. Please view the file CHANGES.DOC for a complete history.
  29.  
  30.  
  31. Overview of Fax-Door
  32. ---------------------------------------------------------------------------
  33. Fax-Door was written to provide users of my BBS the chance to Fax
  34. ASCII Text files to other fax machines in the area.  I originally bought
  35. the Fax Card for my personal benefit, and once I saw how simple it was to
  36. use the BitFax software, I figured it would be a fairly simple job to
  37. create a door to take advantage of the Fax card and BitFax software.
  38.  
  39. A simple door?  Well, that's a matter of opinion I'm sure, but this is
  40. far from being "just a simple door" as you will soon see.
  41.  
  42. My Fax-Door will display information to NewUsers, create a personal ten
  43. number dialing directory, offer a variety of transfer protocols, place
  44. comments in your caller log, as well as a separate door log file, allow
  45. long distance faxing for pre-approved users (you define the number
  46. of credits or available pages), fax on-the-spot, report the fax status,
  47. update user accounts, delete all temporary files....
  48.  
  49. I have the door set up to allow FREE local faxing.  What the hay?  It's
  50. a great service that is fairly cheap to add to your system so why bother
  51. the users and have them pay per fax?
  52.  
  53. All in all, I think you'll be quite pleased.
  54.  
  55.  
  56. Fax-Door Requirements
  57. --------------------------------------------------------------------------
  58. First of all, Fax-Door may not be for everybody.  There are a few
  59. requirements you should be aware of, that may make this door unsuitable for
  60. some Bulletin Board Systems:
  61.  
  62. - You'll need room in your computer for an internal Fax-Card.  That not only
  63.   means phsyical space, but also free interupts and com ports.
  64.  
  65. - You need an extra phone line, in ADDITION to the BBS Line, as the door
  66.   faxes with the caller online.
  67.  
  68. - You need a Fax board that uses the BitFax software (C) 1989 BIT Software,
  69.   Inc.  All Rights Reserved.  I have used BitFax v.2.061 and 2.062
  70.   successfully.  Version 3.0 has also been reported to work fine.
  71.  
  72. - This only works on the node where the Fax card is inserted.  On a multi
  73.   node system, this means the fax service will only be available on one of
  74.   your nodes.
  75.  
  76. - You must have a copy of DSZ in your Path
  77.  
  78. - You'll need lots of free RAM!  The door exits to DOS and runs a BATCH
  79.   file to run BitFax but shells out to DSZ to accept the uploaded file to fax.  Bulletin
  80.   Boards operating under DoubleDos or Desqview must be sure they have
  81.   enough RAM leftover for proper door operation.
  82.  
  83. - The door assumes a local call is 7 or 5 digits in length (minus brackets &
  84.   dashes).  If you are in a location where a local call is more, than you'll
  85.   need a customized version.  Please contact me and provide details and we
  86.   can get you set up.  Example local call:  3425544 or 25544
  87.  
  88. - The door also assumes that a long distance call is 8 or 11 digits in length
  89.   (minus brackets and dashes).  Again, if this a problem in your location
  90.   please contact me and we can get you set up with a customized version.
  91.   Example long distance call:  14163425544 or 13425544
  92.  
  93. - The door will ignore any phone number 4 digits or less, 6, 9 or 10 digits
  94.   or 12 and great and report these as invalid numbers.  If this is a problem
  95.   for you please contact me.
  96.  
  97. - Only 999 users may use the door with all of its bells and whistles.  The
  98.   1000th user and above will have access, but will not have a personal
  99.   dialing directory and therefore have no access to the Long Distance
  100.   option.
  101.  
  102. With all that said, if you still feel this door is for you, then by all
  103. means read on!
  104.  
  105.  
  106. Files needed for Fax-Door Operation
  107. ---------------------------------------------------------------------------
  108. If you have any doubt about the integrity of the files contained in this
  109. ARCHive, feel free to call my BBS in Baltimore, Ontario Canada and download
  110. the latest version.
  111.  
  112.  
  113. DOOR     BAT * | Used when returning from a Fax, explained later
  114. FAXDOOR  CFG * | Your Configuration file, explained later
  115. FAXDOOR  EXE   | The main Fax-Door executible
  116. FAXEDIT  EXE   | User File Editor, explained later
  117. FAXDOOR  REG   | Provided when you Register your copy, explained later
  118. FAXDOOR  PRE * | OPTIONAL list of local prefixes, explained later
  119. FAXING   TXT * | Displayed just as the door exits and goes to send the fax
  120. HELLO2   TXT * | Displayed when a user returns from sending a fax
  121. MENU     TXT * | The Main Menu
  122. MINUS    TXT * | Displayed when attempting to fax LD with a deficit balance
  123. NEWUSER  TXT * | Displayed once, to every new user of the Door
  124. PLUS     TXT * | Displayed before a Long Distance fax if credits remain
  125. XM1KG    BAT * | Xmodem-G transfer batch file (set to use Com1)
  126. XMD1K    BAT * | Xmodem-1K transfer batch file (set to use Com1)
  127. XMDCRC   BAT * | Xmodem-CRC transfer batch file (set to use Com1)
  128. YMD      BAT * | Ymodem transfer batch file (set to use Com1)
  129. YMD1KG   BAT * | Ymodem-1KG transfer batch file (set to use Com1)
  130. ZERO     TXT * | Displayed when attempting to fax LD with no credits left
  131. ZMD      BAT * | Zmodem transfer batch file (set to use Com1)
  132. FAX          * | Sample Batch file to activate the Door, explained later
  133. FAXDOR13 DOC   | This documentation
  134. CHANGES  DOC   | History file listing changes in each version
  135. FAXDV    DOC * | Jon's brain storm on a DV Receive Fax window!
  136. FLYER    DOC   | List of other programs available from me
  137. LICENSE  DOC   | Please read, understand and agree with
  138. SYSOP    DOC   | DoorPatch 3.5 setup instructions
  139. REGISTER FRM   | Print out, complete and mail with register fee
  140. QUICKGO  DOC   | Quick, no muss, no fuss installation & set up
  141. ECHOFAX  DOC   | Information on a message base fax utility now available!
  142.  
  143. Files created by the door
  144.  
  145. FAX      BAT   | Temporary batch file, explained later
  146. DOFAX    YES   | Temporary batch file, explained later
  147. FAXDOR## LOG   | Log file in the door subdirectory of user actions
  148. FAXDOOR  ###   | User Data files, 001-999, explained later
  149. FAXDOOR  DTA   | Master list of User names and their Data File Name
  150.  
  151. Files marked with an asterisk (*) mean you should go over and edit these
  152. files as you see fit.  Be sure to check the transfer batch files so they
  153. are set for the correct com port that the door will be using.
  154.  
  155. All of the above files should be in the same subdirectory as your BitFax
  156. program.  Explainations of their purposes follow.
  157.  
  158.  
  159. DOOR.BAT --> Keep in your Door/BitFax Subdirectory
  160. --------------------------------------------------------------------------
  161. ECHO OFF
  162. FAXDOOR FAXDOOR.CFG
  163. IF EXIST DOFAX.YES FAX
  164. C:
  165. CD\PCB
  166. BOARD
  167.  
  168. You will need to edit this file, if your PCB subdirectory is not located
  169. on Drive C: subdirectory \PCB.  This file is called by the door after
  170. sending a fax and is used to allow the Fax-Door to recycle.
  171. YOU MUST HAVE THIS FILE IN THE DOOR/BITFAX SUBDIRECTORY AND IT MUST HAVE
  172. CORRECT DRIVE LETTERS AND PATHS.
  173.  
  174.  
  175. FAXDOOR.CFG --> Keep in your Door/BitFax Subdirectory
  176. --------------------------------------------------------------------------
  177. C:\PCB\PCBOARD.SYS   | Location of your PCBoard.Sys file
  178. The Phantom BBS      | Your BBS Name
  179. Gerry                | Sysop First Name
  180. Freymann             | Sysop Last Name
  181.  
  182. It's the standard DoorPatch configuration file, so if you have a "generic"
  183. configuration file for DoorPatch doors, you can use that one.
  184.  
  185.  
  186. FAXDOOR.REG --> Place in your Door/BitFax Subdirectory
  187. --------------------------------------------------------------------------
  188. Our new registration process will create this file for you.  When you
  189. register, you are given a small utility program that you run from within
  190. the door subdirectory.  Once you have a valid REG file, the door which
  191. you are already running will magically say Registered to you.
  192.  
  193.  
  194. FAXEDIT.EXE --> Place in your Door/BitFax Subdirectory
  195. --------------------------------------------------------------------------
  196. This is a very nice user file editor for use with the door.  An easy way
  197. to add credits to a user account, or edit somebody's dialing directory,
  198. or just plain be nosy!  One catch.... this only works when you Register
  199. your copy of the Door.  To load the door, pass on the name of one of your
  200. Faxdoor configuration files.  For example:  FAXEDIT FAXDOOR.CFG
  201.  
  202.  
  203. FAXDOOR.PRE --> Place in your Door/BitFax Subdirectory
  204. --------------------------------------------------------------------------
  205. 342
  206. 349
  207. 352
  208. 372
  209. 373
  210. 797
  211. 885
  212.  
  213. This file gives you the chance to ensure that when a user enters a "local"
  214. number, it is indeed a valid local number.  Simply place all valid local
  215. dialing prefixes, one per line in this file.  THIS FILE IS OPTIONAL!  If
  216. you do not create a FaxDoor.Pre file, no validity checks will take place.
  217. As you can see, I don't have a whole heck of a lot of local exchanges, so
  218. it was a piece of cake for me, but in Metropolitan areas, you might spend
  219. a day typing in all the exchanges and might be better off to leave it out!
  220.  
  221.  
  222. *.TXT --> Place in your Door/BitFax Subdirectory
  223. --------------------------------------------------------------------------
  224. These text files are displayed to the user at various points throughout
  225. the door.  You will need to edit some of them, depending on how you wish
  226. to run the door.  I grant free local faxing and the text files provided
  227. display that to the users.  I charge for Long Distance faxing, on a prepaid,
  228. preapproved basis and the text files display that.  You may change and/or
  229. edit any or all of these files as you see fit.
  230.  
  231.  
  232. *.BAT --> Place in your Door/BitFax Subdirectory
  233. --------------------------------------------------------------------------
  234. These are all of your Upload Protocol transfer batch files.  You should
  235. edit these if you aren't using Com1 to run the Fax-Door.
  236.  
  237.  
  238. FAX  --> Place in your \PCB Subdirectory
  239. FAX.BAT --> Created and maintained by the Door
  240. DOFAX.YES --> Created and maintained by the Door
  241. --------------------------------------------------------------------------
  242. ECHO OFF                       | Turn Echo OFF
  243. T:                             | Log to Drive T:
  244. CD\BITFAX                      | Change Directory to the BitFax/Door area
  245. FAXDOOR FAXDOOR.CFG            | Load the door and using the .cfg file
  246. IF EXIST DOFAX.YES FAX         | Key file maintained by the door
  247. C:                             | Log back to starting drive
  248. CD\PCB                         | Change back to main \PCB area
  249. BOARD                          | Reload the BBS
  250.  
  251. This is my door batch file that calls up the FaxDoor.  Using the name "FAX"
  252. a user can simply type FAX at the PCBoard 14.5 prompt and be taken into
  253. the Fax door.  The If Exist line is the key to calling up the BitFax
  254. software.  The door will automatically create a FAX.BAT file which will
  255. instruct BitFax on what file to send and what number to dial.  The end of
  256. FAX.BAT calls DOOR.BAT (Door.Bat is provided and was discussed earlier)
  257. and allows the Fax-Door to reload and gather stats etc.  The file DOFAX.YES
  258. is also created by the door and holds some data which the door reads after
  259. sending the fax to complete the statistic gathering.  Both of these files
  260. are deleted automatically by the door.
  261.  
  262.  
  263. FAXDOOR.###  --> Created and maintained by the Door
  264. --------------------------------------------------------------------------
  265. "PHANTOM BBS","342-5544"
  266. "**","**"
  267. "**","**"
  268. "**","**"
  269. "**","**"
  270. "**","**"
  271. "**","**"
  272. "**","**"
  273. "**","**"
  274. "**","**"
  275. " 0","N"
  276.  
  277. These files are the User Files created by the door.  They are numbered
  278. 001 to 999.  The format is very simple.  It's an ASCII file with two
  279. fields per line, separated by a comma with each field surrounded by
  280. quotation marks.  The first field is a description of the number and
  281. the second field is the actual fax number.  There are ten lines providing
  282. each user with their very own personal ten number dialing directory.  A
  283. user may enter a number manually or dial a number contained in their
  284. directory.
  285.  
  286. The last line is rather unique.  The first field of the eleventh line
  287. will start at zero.  If you wish to grant Long Distance faxing to a user
  288. you need to read FAXDOOR.DTA to get their filename, then edit this line
  289. in their file and insert the number of "credits" or pages you wish them
  290. to have.  Try to remember to leave a leading space before the number?
  291. The door will only allow a person to fax to a long distance number if they
  292. have a postive value.  If they have 0 or a negative number, no long distance
  293. faxing will be allowed (local faxes remain available).  The door will
  294. maintain the number of credits for you and displays certain TXT files
  295. after a successful fax based on the value in this field.
  296.  
  297. The second field is not in use at this time and has been left in for
  298. future uses.  Both fields, as with the rest of the datafile, should be
  299. surrounded by quotes and separated by a comma.
  300.  
  301. If you register your copy of Fax-Door the FAXEDIT program will magically
  302. start to work and you won't really have to bother with all this stuff.
  303.  
  304. Only 999 users may use the door with all of its bells and whistles.  The
  305. 1000th user and above will have access, but will not have a personal
  306. dialing directory and therefore have no access to the Long Distance
  307. option.
  308.  
  309.  
  310. FAXDOOR.DTA  --> Created and maintained by the Door
  311. --------------------------------------------------------------------------
  312. "USER ONE","FAXDOOR.001"
  313. "USER TWO","FAXDOOR.002"
  314. "USER THREE","FAXDOOR.003"
  315. "USER FOUR","FAXDOOR.004"
  316.  
  317. This is only a sample of the Data file created by the door.  It is a simple
  318. ASCII file with two fields per line, surrounded by quotation marks and
  319. separated by a comma.  The first field is the User Name and the second
  320. field is the name of their personal data file (explained above).  You are
  321. limited to 1000 users!
  322.  
  323.  
  324. FAXDOR## LOG  --> Created and maintained by the Door
  325. --------------------------------------------------------------------------
  326. **************************************************************
  327. GERRY FREYMANN entered FAX-DOOR 02-13-1991 22:58:28
  328. Uploaded TEST.FAX using Zmodem
  329. Dial (A)borted!
  330. **************************************************************
  331. GERRY FREYMANN entered FAX-DOOR 02-13-1991 23:50:38
  332. Uploaded TEST.FAX using Zmodem
  333. Faxing TEST.FAX to 3425544
  334. CFMX.FAX      1     00:25    OK
  335. Uploaded TEST.DOC using Zmodem
  336. File transfer was UNSUCCESSFUL.
  337.  
  338. This is a log file that the door appends to, giving you a history of
  339. activity in the door.  If you are running on a multinode system you will
  340. see the node number appended to the end of the prefix.  Since this file
  341. appends, you may wish to delete or archive it periodically.
  342.  
  343.  
  344. FAXDV.DOC --> Created by Jon Anderson, used by permission
  345. ----------------------------------------------------------------------------
  346. Information and complete batch file to open a window in Desqview for a
  347. receive fax option using BitFax 3.0 - take a peek!
  348.  
  349.  
  350. Setting up BitFax
  351. --------------------------------------------------------------------------
  352. I followed the instructions for BitFax when installing the software and
  353. suggest you do the same.  Make a subdirectory called BITFAX on your drive,
  354. change to the subdirectory, and copy the contents of the BitFax/SR Program
  355. disk into the subdirectory.  You should place the Fax-Door files in this
  356. same directory, as the Fax-Door will read the Log file created by BitFax.
  357. You should set the BITFAX=\BITFAX environment variable in your autoexec.bat
  358. file, and include the BITFAX subdirectory in your PATH= statement.
  359.  
  360. Be sure to set your com port correctly on the fax card.  I run a Hayes
  361. Ultra on Com1 and have the fax card set to use Com3/IRQ 4.  I elected
  362. to have the Modem Speaker OFF at all times... it is rather loud!
  363.  
  364. Once your card is installed and your software is loaded onto the hard
  365. drive you should type BITFAX and set up the BitFax parameters.  Please
  366. follow the BitFax manual.  Their manual contains step by step instructions.
  367.  
  368.  
  369. Future Plans
  370. ---------------------------------------------------------------------------
  371. I'm currently working on an event utility that will scan a message base
  372. for outgoing faxes.  Some SysOps have already expressed a desire for an
  373. event based/message based fax system rather than the door.  When I get
  374. this program released, I will make it available to all registered Fax-Door
  375. users for another $15.00.  The event utility will be based around the
  376. BitFax software, but does not need the door to work.  If you only want
  377. the event utility, it will cost $20.00.  The door, all by itself is only
  378. $10.00.  Both programs together will cost $25.00.
  379.  
  380.  
  381. Registration Cost
  382. ---------------------------------------------------------------------------
  383. The DOOR only costs $10.00!!  It is a full working version and is not
  384. crippled in anyway.
  385.  
  386.  
  387. Support the Shareware concept...
  388. ---------------------------------------------------------------------------
  389. To Register, please print out and return the REGISTER.FRM in the Zip file.
  390. Now, when you register, you will be given a small program which you run in
  391. your door subdirectory.  This program will create a *.REG which will
  392. instantly register your existing copy of the door program, and any and all
  393. future versions as well.  This means that any future releases you find will
  394. automatically continue to say registered to you, without the need to come
  395. back to me.  I hope you'll appreciate this new system.  You should be able
  396. to call The Phantom BBS and make your initial call, wait until I receive
  397. your payment, and download this small utility without spending alot of time
  398. on the phone.  Or, for an additional $5.00 per order, I can send you the
  399. whole package on disk using the postal service.  The choice is yours.
  400. There is an Update Door which grants access to all Registered Users, and
  401. allows you to download your register utilities for the programs you have
  402. registered.
  403.  
  404.  
  405. Thanks for your support!
  406.  
  407.